<?php

/*
 * This file is part of Twig.
 *
 * (c) 2009 Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

/**
 * Loads a template from an array.
 *
 * When using this loader with a cache mehcanism, you should know that a new cache
 * key is generated each time a template content "changes" (the cache key being the
 * source code of the template). If you don't want to see your cache grows out of
 * control, you need to take care of clearing the old cache file by yourself.
 *
 * @package    twig
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>
 * @version    SVN: $Id$
 */
class Twig_Loader_Array implements Twig_LoaderInterface
{
  protected $templates;

  /**
   * Constructor.
   *
   * @param array $templates An array of templates (keys are the names, and values are the source code)
   *
   * @see Twig_Loader
   */
  public function __construct(array $templates)
  {
    $this->templates = array();
    foreach ($templates as $name => $template)
    {
      $this->templates[$name] = $template;
    }
  }

  /**
   * Gets the source code of a template, given its name.
   *
   * @param  string $name string The name of the template to load
   *
   * @return string The template source code
   */
  public function getSource($name)
  {
    if (!isset($this->templates[$name]))
    {
      throw new LogicException(sprintf('Template "%s" is not defined.', $name));
    }

    return $this->templates[$name];
  }

  /**
   * Gets the cache key to use for the cache for a given template name.
   *
   * @param  string $name string The name of the template to load
   *
   * @return string The cache key
   */
  public function getCacheKey($name)
  {
    if (!isset($this->templates[$name]))
    {
      throw new LogicException(sprintf('Template "%s" is not defined.', $name));
    }

    return $this->templates[$name];
  }

  /**
   * Returns true if the template is still fresh.
   *
   * @param string    $name The template name
   * @param timestamp $time The last modification time of the cached template
   */
  public function isFresh($name, $time)
  {
    return true;
  }
}
